API Endpoint
https://api.xure.co/v1/lookup/countries/{countrycode}

Obtain business identifier descriptions for a specific country

Path Parameters
ParameterDescription
countrycode 

View Country Configuration GET

Parameters

Response Parameters
ParameterDescription
CountryName StringThe name of the country
CountryCode StringThe three-letter ISO code assigned to the country
Identifiers ListThe list of identifiers that are recorded for businesses operating within this country
Type String
The unique reference to use when referencing an identifier of this type
Name String
The name of the identifier
Format String
A regular expression defining the expected format of the identifierOptional
Description String
A description to be shown to the user when prompted to enter this identifierOptional

XML

Example Request
GET https://api.xure.co/v1/lookup/countries/{countrycode}.eb HTTP/1.1
Accept: text/xml
Response Schema
<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="CountryDetails">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="CountryName" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The name of the country</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="CountryCode" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>The three-letter ISO code assigned to the country</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="Identifiers">
          <xsd:annotation>
            <xsd:documentation>The list of identifiers that are recorded for businesses operating within this country</xsd:documentation>
          </xsd:annotation>
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="Type" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>The unique reference to use when referencing an identifier of this type</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="Name" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>The name of the identifier</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="Format" minOccurs="0" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>A regular expression defining the expected format of the identifier</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="Description" minOccurs="0" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>A description to be shown to the user when prompted to enter this identifier</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                  </xsd:sequence>
                </xsd:complexType>
              </xsd:element>
            </xsd:sequence>
          </xsd:complexType>
        </xsd:element>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>
Example Response
HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<CountryDetails>
  <CountryName>xsd:string</CountryName>
  <CountryCode>xsd:string</CountryCode>
  <Identifiers>
    <Item>
      <Type>xsd:string</Type>
      <Name>xsd:string</Name>
      <Format>xsd:string</Format>
      <Description>xsd:string</Description>
    </Item>...</Identifiers>
</CountryDetails>

JSON

Example Request
GET https://api.xure.co/v1/lookup/countries/{countrycode}.eb HTTP/1.1
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json

{"CountryName":String,
  "CountryCode":String,
  "Identifiers":[{"Type":String,
      "Name":String,
      "Format":String,
      "Description":String},
    ...]}